Skip to content

More narrative explination of a time series.#1812

Open
MikeNeilson wants to merge 2 commits into
developfrom
task/1809-timeseries-documentation
Open

More narrative explination of a time series.#1812
MikeNeilson wants to merge 2 commits into
developfrom
task/1809-timeseries-documentation

Conversation

@MikeNeilson

@MikeNeilson MikeNeilson commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Additional definition and description of time series components.

Ideas to make better welcome. I've intentionally not made any graphics, wasn't sure exactly what needed it the most. Thoughts on that also welcome.

Also I did this is 2 hours straight starting this morning... please don't pretend I write perfect prose the first time. Spelling, Grammar, and other corrections, are most definitely welcome.... In fact, I demand them.

Related Issue

Closes #1809

Validation

Manually validated that sphinx docs generated and visually looked as expected.

Checklist

  • AI tools used

@krowvin krowvin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see spelling errors as well:

Psuedo/Pseudo
Offets/Offsets
instananeous/instantaneous
Constnat/Constant
Begining/Beginning

Comment on lines +133 to +134
Regular, Irregular, Psuedo Regular, and Local Regular
=====================================================

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be the same level as the page title?

Suggested change
Regular, Irregular, Psuedo Regular, and Local Regular
=====================================================
Regular, Irregular, Psuedo Regular, and Local Regular
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Inst, Instantenous, Samples measured \"now\". For example if you take a measuring type and measure the length of a piece of wood.
Ave, Average, "Samples are a composite of other samples, using some averaging technique."
Total, Total, "Samples are a composite of other samples, using sum of inputs over time."

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We mention total and inc in this table but not cumulative

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for LRTS / Pseudo Irregular to RTD

2 participants